dacat-api (3.0.1)

Download OpenAPI specification:Download

dacat-api

User

Find a related item by id for accessTokens.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for accessTokens

Responses

Response samples

Content type
{
  • "id": "string",
  • "ttl": 1209600,
  • "scopes":
    [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "userId": "string"
}

Delete a related item by id for accessTokens.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for accessTokens

Responses

Update a related item by id for accessTokens.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for accessTokens

Request Body schema:
id
required
string
ttl
number <double>
Default: 1209600

time to live in seconds (2 weeks by default)

scopes
Array of strings

Array of scopes granted to this access token.

created
string <date-time>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": "string",
  • "ttl": 1209600,
  • "scopes":
    [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "userId": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "ttl": 1209600,
  • "scopes":
    [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "userId": "string"
}

Fetches hasOne relation settings.

path Parameters
id
required
string <JSON>

User id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Creates a new instance in settings of this model.

path Parameters
id
required
string <JSON>

User id

Request Body schema:
columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Update settings of this model.

path Parameters
id
required
string <JSON>

User id

Request Body schema:
columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Deletes settings of this model.

path Parameters
id
required
string <JSON>

User id

Responses

Find a related item by id for identities.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for identities

Responses

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Delete a related item by id for identities.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for identities

Responses

Update a related item by id for identities.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for identities

Request Body schema:
id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Find a related item by id for credentials.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for credentials

Responses

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Delete a related item by id for credentials.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for credentials

Responses

Update a related item by id for credentials.

path Parameters
id
required
string <JSON>

User id

fk
required
string <JSON>

Foreign key for credentials

Request Body schema:
provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Queries accessTokens of User.

path Parameters
id
required
string <JSON>

User id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in accessTokens of this model.

path Parameters
id
required
string <JSON>

User id

Request Body schema:
id
required
string
ttl
number <double>
Default: 1209600

time to live in seconds (2 weeks by default)

scopes
Array of strings

Array of scopes granted to this access token.

created
string <date-time>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": "string",
  • "ttl": 1209600,
  • "scopes":
    [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "userId": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "ttl": 1209600,
  • "scopes":
    [
    ],
  • "created": "2019-08-24T14:15:22Z",
  • "userId": "string"
}

Deletes all accessTokens of this model.

path Parameters
id
required
string <JSON>

User id

Responses

Counts accessTokens of User.

path Parameters
id
required
string <JSON>

User id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries identities of User.

path Parameters
id
required
string <JSON>

User id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in identities of this model.

path Parameters
id
required
string <JSON>

User id

Request Body schema:
id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Deletes all identities of this model.

path Parameters
id
required
string <JSON>

User id

Responses

Counts identities of User.

path Parameters
id
required
string <JSON>

User id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries credentials of User.

path Parameters
id
required
string <JSON>

User id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in credentials of this model.

path Parameters
id
required
string <JSON>

User id

Request Body schema:
provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Deletes all credentials of this model.

path Parameters
id
required
string <JSON>

User id

Responses

Counts credentials of User.

path Parameters
id
required
string <JSON>

User id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

User id

Request Body schema:

An object of model property name/value pairs

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

realm
string
username
string
email
required
string
emailVerified
boolean
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Login a user with username/email and password.

query Parameters
include
string <JSON>

Related objects to include in the response. See the description of return value for more details.

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Logout a user with access token.

Responses

Trigger user's identity verification with configured verifyOptions

path Parameters
id
required
string <JSON>

User id

Responses

Confirm a user registration with identity verification token.

query Parameters
uid
required
string
token
required
string
redirect
string

Responses

Reset password for a user with email.

Request Body schema:

Responses

Request samples

Content type
{ }

Change a user's password.

Request Body schema: application/x-www-form-urlencoded
oldPassword
required
string
newPassword
required
string

Responses

Reset user's password via a password-reset token.

Request Body schema: application/x-www-form-urlencoded
newPassword
required
string

Responses

Returns username, email , group membership etc for the user linked with the provided accessToken.

Responses

Response samples

Content type
{ }

User.jwt

Responses

Response samples

Content type
{
  • "jwt": "string"
}

Dataset

Stores the meta data information for a given collection of files. It defines a list of mandatory and optional metadata fields to be defined. Datasets have a PID field for unique identification. This is the base 'class' for derived documents like raw datasets or derived datasets. The type field is used to distinguish between the different types of datasets. For each dataset in addition an embedded DatasetLifecycle is created. However the definition of which files belong to a given dataset is defined in an extra OrigDatablock collection.

Find a related item by id for samples.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for samples

Responses

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for samples.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for samples

Responses

Update a related item by id for samples.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for samples

Request Body schema:
sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation publisheddata.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches hasOne relation datasetLifecycle.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Creates a new instance in datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
archivable
boolean

Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet.

retrievable
boolean

Flag which is true, if dataset is stored on archive system and is ready to be retrieved.

publishable
boolean

Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar.

dateOfDiskPurging
string <date-time>

Day when dataset will be removed from disk, assuming that is already stored on tape.

archiveRetentionTime
string <date-time>

Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive.

dateOfPublishing
string <date-time>

Day when dataset is supposed to become public according to data policy

isOnCentralDisk
boolean

Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time

archiveStatusMessage
string

Short string defining current status of Dataset with respect to storage on disk/tape.

retrieveStatusMessage
string

Latest message for this dataset concerning retrieve from archive system.

archiveReturnMessage
object

Detailed status or error message returned by archive system when archiving this dataset.

retrieveReturnMessage
object

Detailed status or error message returned by archive system when retrieving this dataset.

exportedTo
string

Location of the last export destination.

retrieveIntegrityCheck
boolean

Set to true when checksum tests after retrieve of datasets were successful

id
string

Responses

Request samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Update datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
archivable
boolean

Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet.

retrievable
boolean

Flag which is true, if dataset is stored on archive system and is ready to be retrieved.

publishable
boolean

Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar.

dateOfDiskPurging
string <date-time>

Day when dataset will be removed from disk, assuming that is already stored on tape.

archiveRetentionTime
string <date-time>

Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive.

dateOfPublishing
string <date-time>

Day when dataset is supposed to become public according to data policy

isOnCentralDisk
boolean

Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time

archiveStatusMessage
string

Short string defining current status of Dataset with respect to storage on disk/tape.

retrieveStatusMessage
string

Latest message for this dataset concerning retrieve from archive system.

archiveReturnMessage
object

Detailed status or error message returned by archive system when archiving this dataset.

retrieveReturnMessage
object

Detailed status or error message returned by archive system when retrieving this dataset.

exportedTo
string

Location of the last export destination.

retrieveIntegrityCheck
boolean

Set to true when checksum tests after retrieve of datasets were successful

id
string

Responses

Request samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Deletes datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

Dataset id

Responses

Find a related item by id for datablocks.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for datablocks

Responses

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for datablocks.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for datablocks

Responses

Update a related item by id for datablocks.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for datablocks

Request Body schema:
id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Responses

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Responses

Update a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Request Body schema:
id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find a related item by id for historyList.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for historyList

Responses

Response samples

Content type
{
  • "id": "string"
}

Delete a related item by id for historyList.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for historyList

Responses

Update a related item by id for historyList.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for historyList

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

Responses

Request samples

Content type
{
  • "id": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Find a related item by id for attachments.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for attachments

Responses

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for attachments.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for attachments

Responses

Update a related item by id for attachments.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for attachments

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation instrument.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Find a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for techniquesList

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Delete a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for techniquesList

Responses

Update a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

Dataset id

fk
required
string <JSON>

Foreign key for techniquesList

Request Body schema:
pid
required
string

Persistent Identifier dervied from UUIDv4

name
required
string

The name of the technique

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Queries samples of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in samples of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all samples of this model.

path Parameters
id
required
string <JSON>

Dataset id

Responses

Counts samples of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries datablocks of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in datablocks of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all datablocks of this model.

path Parameters
id
required
string <JSON>

Dataset id

Responses

Counts datablocks of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries origdatablocks of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in origdatablocks of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all origdatablocks of this model.

path Parameters
id
required
string <JSON>

Dataset id

Responses

Counts origdatablocks of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries historyList of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in historyList of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

Responses

Request samples

Content type
{
  • "id": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Deletes all historyList of this model.

path Parameters
id
required
string <JSON>

Dataset id

Responses

Counts historyList of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries attachments of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in attachments of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all attachments of this model.

path Parameters
id
required
string <JSON>

Dataset id

Responses

Counts attachments of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries techniquesList of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in techniquesList of this model.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:
pid
required
string

Persistent Identifier dervied from UUIDv4

name
required
string

The name of the technique

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Deletes all techniquesList of this model.

path Parameters
id
required
string <JSON>

Dataset id

Responses

Counts techniquesList of Dataset.

path Parameters
id
required
string <JSON>

Dataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:

An object of model property name/value pairs

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Dataset id

Request Body schema:

An object of model property name/value pairs

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Reset archive status by deleting created datablocks of dataset and resetting archiveStatusMessage and archivable flag.

Request Body schema: application/x-www-form-urlencoded
datasetId
string

Responses

Response samples

Content type
{ }

Return facet counts relevant for the given selected subset of datasets.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name and values of fields. There ia also support for a text search to look for strngs anywhere in the dataset.

facets
string <JSON>

Defines list of field names, for which facet counts should be calculated

Responses

Response samples

Content type
{ }

Return datasets fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There ia also support for a text search to look for strings anywhere in the dataset. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

Return datasets fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There ia also support for a text search to look for strings anywhere in the dataset. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

updates a single record by appending data to the specified field

path Parameters
id
required
string
Request Body schema: application/x-www-form-urlencoded
fieldName
required
string

Name of field to append data to

data
required
string <JSON>

An array of values to append

Responses

Response samples

Content type
{ }

Return array of metadata keys from datasets corresponding to the current filters.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There is also support for a text search to look for strings anywhere in the dataset.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

Dataset.thumbnail

path Parameters
id
required
string

Responses

Response samples

Content type
"string"

Sends a post request for Dataset reduction to OpenWhisk

Request Body schema:

The Dataset to send for reduction

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{ }

RawDataset

Contains the information for datasets which are the result of measurements or of simulations. Often raw datasets are automatically added as part of an automated ingest step as part of the data acquisition chain at an instrument. This schema inherits the fields from the generic Dataset collection and adds specific fields as defined below.

Find a related item by id for samples.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for samples

Responses

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for samples.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for samples

Responses

Update a related item by id for samples.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for samples

Request Body schema:
sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation sample.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation proposal.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Fetches belongsTo relation publisheddata.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches hasOne relation datasetLifecycle.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Creates a new instance in datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
archivable
boolean

Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet.

retrievable
boolean

Flag which is true, if dataset is stored on archive system and is ready to be retrieved.

publishable
boolean

Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar.

dateOfDiskPurging
string <date-time>

Day when dataset will be removed from disk, assuming that is already stored on tape.

archiveRetentionTime
string <date-time>

Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive.

dateOfPublishing
string <date-time>

Day when dataset is supposed to become public according to data policy

isOnCentralDisk
boolean

Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time

archiveStatusMessage
string

Short string defining current status of Dataset with respect to storage on disk/tape.

retrieveStatusMessage
string

Latest message for this dataset concerning retrieve from archive system.

archiveReturnMessage
object

Detailed status or error message returned by archive system when archiving this dataset.

retrieveReturnMessage
object

Detailed status or error message returned by archive system when retrieving this dataset.

exportedTo
string

Location of the last export destination.

retrieveIntegrityCheck
boolean

Set to true when checksum tests after retrieve of datasets were successful

id
string

Responses

Request samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Update datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
archivable
boolean

Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet.

retrievable
boolean

Flag which is true, if dataset is stored on archive system and is ready to be retrieved.

publishable
boolean

Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar.

dateOfDiskPurging
string <date-time>

Day when dataset will be removed from disk, assuming that is already stored on tape.

archiveRetentionTime
string <date-time>

Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive.

dateOfPublishing
string <date-time>

Day when dataset is supposed to become public according to data policy

isOnCentralDisk
boolean

Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time

archiveStatusMessage
string

Short string defining current status of Dataset with respect to storage on disk/tape.

retrieveStatusMessage
string

Latest message for this dataset concerning retrieve from archive system.

archiveReturnMessage
object

Detailed status or error message returned by archive system when archiving this dataset.

retrieveReturnMessage
object

Detailed status or error message returned by archive system when retrieving this dataset.

exportedTo
string

Location of the last export destination.

retrieveIntegrityCheck
boolean

Set to true when checksum tests after retrieve of datasets were successful

id
string

Responses

Request samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Deletes datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Responses

Find a related item by id for datablocks.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for datablocks

Responses

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for datablocks.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for datablocks

Responses

Update a related item by id for datablocks.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for datablocks

Request Body schema:
id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Responses

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Responses

Update a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Request Body schema:
id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find a related item by id for historyList.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for historyList

Responses

Response samples

Content type
{
  • "id": "string"
}

Delete a related item by id for historyList.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for historyList

Responses

Update a related item by id for historyList.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for historyList

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

Responses

Request samples

Content type
{
  • "id": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Find a related item by id for attachments.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for attachments

Responses

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for attachments.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for attachments

Responses

Update a related item by id for attachments.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for attachments

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation instrument.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Find a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for techniquesList

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Delete a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for techniquesList

Responses

Update a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

RawDataset id

fk
required
string <JSON>

Foreign key for techniquesList

Request Body schema:
pid
required
string

Persistent Identifier dervied from UUIDv4

name
required
string

The name of the technique

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Queries samples of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in samples of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all samples of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Responses

Counts samples of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries datablocks of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in datablocks of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all datablocks of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Responses

Counts datablocks of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries origdatablocks of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in origdatablocks of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all origdatablocks of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Responses

Counts origdatablocks of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries historyList of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in historyList of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

Responses

Request samples

Content type
{
  • "id": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Deletes all historyList of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Responses

Counts historyList of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries attachments of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in attachments of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all attachments of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Responses

Counts attachments of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries techniquesList of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in techniquesList of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:
pid
required
string

Persistent Identifier dervied from UUIDv4

name
required
string

The name of the technique

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Deletes all techniquesList of this model.

path Parameters
id
required
string <JSON>

RawDataset id

Responses

Counts techniquesList of RawDataset.

path Parameters
id
required
string <JSON>

RawDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:

An object of model property name/value pairs

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

RawDataset id

Request Body schema:

An object of model property name/value pairs

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

principalInvestigator
required
string

Email of principal investigator

endTime
string <date-time>

Time of end of data taking for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

creationLocation
required
string

Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name

dataFormat
string

Defines format of subsequent scientific meta data, e.g Nexus Version x.y

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
sampleId
string
proposalId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "principalInvestigator": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "creationLocation": "string",
  • "dataFormat": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "sampleId": "string",
  • "proposalId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Reset archive status by deleting created datablocks of dataset and resetting archiveStatusMessage and archivable flag.

Request Body schema: application/x-www-form-urlencoded
datasetId
string

Responses

Response samples

Content type
{ }

Return facet counts relevant for the given selected subset of datasets.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name and values of fields. There ia also support for a text search to look for strngs anywhere in the dataset.

facets
string <JSON>

Defines list of field names, for which facet counts should be calculated

Responses

Response samples

Content type
{ }

Return datasets fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There ia also support for a text search to look for strings anywhere in the dataset. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

Return datasets fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There ia also support for a text search to look for strings anywhere in the dataset. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

DerivedDataset

Contains the information for datasets which are the result of an analysis step, typically based on raw datasets or other derived datasets as input. Derived datasets are typically added by the researcher pursuing the specific analysis. This schema inherits the fields from the generic Dataset collection and adds specific fields as defined below.

Find a related item by id for samples.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for samples

Responses

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for samples.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for samples

Responses

Update a related item by id for samples.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for samples

Request Body schema:
sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation publisheddata.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches hasOne relation datasetLifecycle.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Creates a new instance in datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
archivable
boolean

Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet.

retrievable
boolean

Flag which is true, if dataset is stored on archive system and is ready to be retrieved.

publishable
boolean

Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar.

dateOfDiskPurging
string <date-time>

Day when dataset will be removed from disk, assuming that is already stored on tape.

archiveRetentionTime
string <date-time>

Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive.

dateOfPublishing
string <date-time>

Day when dataset is supposed to become public according to data policy

isOnCentralDisk
boolean

Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time

archiveStatusMessage
string

Short string defining current status of Dataset with respect to storage on disk/tape.

retrieveStatusMessage
string

Latest message for this dataset concerning retrieve from archive system.

archiveReturnMessage
object

Detailed status or error message returned by archive system when archiving this dataset.

retrieveReturnMessage
object

Detailed status or error message returned by archive system when retrieving this dataset.

exportedTo
string

Location of the last export destination.

retrieveIntegrityCheck
boolean

Set to true when checksum tests after retrieve of datasets were successful

id
string

Responses

Request samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Update datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
archivable
boolean

Flag which is true, if dataset is available to be archived and no archive job for this dataset exists yet.

retrievable
boolean

Flag which is true, if dataset is stored on archive system and is ready to be retrieved.

publishable
boolean

Flag which is true, if dataset can be published. Usually requires a longterm storage option on tape or similar.

dateOfDiskPurging
string <date-time>

Day when dataset will be removed from disk, assuming that is already stored on tape.

archiveRetentionTime
string <date-time>

Day when the dataset's future fate will be evaluated again, e.g. to decide if the dataset can be deleted from archive.

dateOfPublishing
string <date-time>

Day when dataset is supposed to become public according to data policy

isOnCentralDisk
boolean

Flag which is true, if full dataset is available on central fileserver. If false data needs to be copied from decentral storage place to a cache server before the ingest. This information needs to be transferred to the archive system at archive time

archiveStatusMessage
string

Short string defining current status of Dataset with respect to storage on disk/tape.

retrieveStatusMessage
string

Latest message for this dataset concerning retrieve from archive system.

archiveReturnMessage
object

Detailed status or error message returned by archive system when archiving this dataset.

retrieveReturnMessage
object

Detailed status or error message returned by archive system when retrieving this dataset.

exportedTo
string

Location of the last export destination.

retrieveIntegrityCheck
boolean

Set to true when checksum tests after retrieve of datasets were successful

id
string

Responses

Request samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Response samples

Content type
{
  • "archivable": true,
  • "retrievable": true,
  • "publishable": true,
  • "dateOfDiskPurging": "2019-08-24T14:15:22Z",
  • "archiveRetentionTime": "2019-08-24T14:15:22Z",
  • "dateOfPublishing": "2019-08-24T14:15:22Z",
  • "isOnCentralDisk": true,
  • "archiveStatusMessage": "string",
  • "retrieveStatusMessage": "string",
  • "archiveReturnMessage": { },
  • "retrieveReturnMessage": { },
  • "exportedTo": "string",
  • "retrieveIntegrityCheck": true,
  • "id": "string"
}

Deletes datasetLifecycle of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Responses

Find a related item by id for datablocks.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for datablocks

Responses

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for datablocks.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for datablocks

Responses

Update a related item by id for datablocks.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for datablocks

Request Body schema:
id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Responses

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Responses

Update a related item by id for origdatablocks.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for origdatablocks

Request Body schema:
id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find a related item by id for historyList.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for historyList

Responses

Response samples

Content type
{
  • "id": "string"
}

Delete a related item by id for historyList.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for historyList

Responses

Update a related item by id for historyList.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for historyList

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

Responses

Request samples

Content type
{
  • "id": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Find a related item by id for attachments.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for attachments

Responses

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for attachments.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for attachments

Responses

Update a related item by id for attachments.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for attachments

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation instrument.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Find a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for techniquesList

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Delete a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for techniquesList

Responses

Update a related item by id for techniquesList.

path Parameters
id
required
string <JSON>

DerivedDataset id

fk
required
string <JSON>

Foreign key for techniquesList

Request Body schema:
pid
required
string

Persistent Identifier dervied from UUIDv4

name
required
string

The name of the technique

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Queries samples of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in samples of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all samples of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Responses

Counts samples of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries datablocks of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in datablocks of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all datablocks of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Responses

Counts datablocks of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries origdatablocks of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in origdatablocks of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all origdatablocks of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Responses

Counts origdatablocks of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries historyList of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in historyList of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

Responses

Request samples

Content type
{
  • "id": "string"
}

Response samples

Content type
{
  • "id": "string"
}

Deletes all historyList of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Responses

Counts historyList of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries attachments of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in attachments of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all attachments of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Responses

Counts attachments of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries techniquesList of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in techniquesList of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:
pid
required
string

Persistent Identifier dervied from UUIDv4

name
required
string

The name of the technique

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string"
}

Deletes all techniquesList of this model.

path Parameters
id
required
string <JSON>

DerivedDataset id

Responses

Counts techniquesList of DerivedDataset.

path Parameters
id
required
string <JSON>

DerivedDataset id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:

An object of model property name/value pairs

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

DerivedDataset id

Request Body schema:

An object of model property name/value pairs

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

investigator
required
string

Email of person pursuing the data analysis

inputDatasets
required
Array of strings

Array of input dataset identifiers used in producing the derived dataset. Ideally these are the global identifier to existing datasets inside this or federated data catalogs

usedSoftware
required
Array of strings

A list of links to software repositories which uniquely identifies the software used and the version for yielding the derived data

jobParameters
object

The creation process of the drived data will usually depend on input job parameters. The full structure of these input parameters are stored here

jobLogData
string

The output job logfile. Keep the size of this log data well below 15 MB

scientificMetadata
object

JSON object containing the scientific meta data

pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "investigator": "string",
  • "inputDatasets":
    [
    ],
  • "usedSoftware":
    [
    ],
  • "jobParameters": { },
  • "jobLogData": "string",
  • "scientificMetadata": { },
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Reset archive status by deleting created datablocks of dataset and resetting archiveStatusMessage and archivable flag.

Request Body schema: application/x-www-form-urlencoded
datasetId
string

Responses

Response samples

Content type
{ }

Return facet counts relevant for the given selected subset of datasets.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name and values of fields. There ia also support for a text search to look for strngs anywhere in the dataset.

facets
string <JSON>

Defines list of field names, for which facet counts should be calculated

Responses

Response samples

Content type
{ }

Return datasets fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There ia also support for a text search to look for strings anywhere in the dataset. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

Return datasets fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There ia also support for a text search to look for strings anywhere in the dataset. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

Sample

Models describing the characteristics of the samples to be investigated. Raw datasets should be linked to such sample definitions.

Fetches belongsTo relation datasets.

path Parameters
id
required
string <JSON>

Sample id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Find a related item by id for attachments.

path Parameters
id
required
string <JSON>

Sample id

fk
required
string <JSON>

Foreign key for attachments

Responses

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for attachments.

path Parameters
id
required
string <JSON>

Sample id

fk
required
string <JSON>

Foreign key for attachments

Responses

Update a related item by id for attachments.

path Parameters
id
required
string <JSON>

Sample id

fk
required
string <JSON>

Foreign key for attachments

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Queries attachments of Sample.

path Parameters
id
required
string <JSON>

Sample id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in attachments of this model.

path Parameters
id
required
string <JSON>

Sample id

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all attachments of this model.

path Parameters
id
required
string <JSON>

Sample id

Responses

Counts attachments of Sample.

path Parameters
id
required
string <JSON>

Sample id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Sample id

Request Body schema:

An object of model property name/value pairs

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

sampleId
required
string
owner
string
description
string
createdAt
string <date-time>
sampleCharacteristics
object
isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetsId
string
datasetId
string
rawDatasetId
string
derivedDatasetId
string
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Return samples fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There is also support for a text search to look for strings anywhere in the sample. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

Proposal

Defines the purpose of an experiment and links an experiment to principal investigator and main proposer

Find a related item by id for measurementPeriods.

path Parameters
id
required
string <JSON>

Proposal id

fk
required
string <JSON>

Foreign key for measurementPeriods

Responses

Response samples

Content type
{
  • "id": "string",
  • "instrument": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

Delete a related item by id for measurementPeriods.

path Parameters
id
required
string <JSON>

Proposal id

fk
required
string <JSON>

Foreign key for measurementPeriods

Responses

Update a related item by id for measurementPeriods.

path Parameters
id
required
string <JSON>

Proposal id

fk
required
string <JSON>

Foreign key for measurementPeriods

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

instrument
required
string

Instrument or beamline identifier where measurement was pursued, e.g. /PSI/SLS/TOMCAT

start
string <date-time>

Time when measurement period started, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

end
string <date-time>

Time when measurement period ended, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

comment
string

Additional information relevant for this measurement period, e.g. if different accounts were used for data taking

Responses

Request samples

Content type
{
  • "id": "string",
  • "instrument": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "instrument": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

Find a related item by id for attachments.

path Parameters
id
required
string <JSON>

Proposal id

fk
required
string <JSON>

Foreign key for attachments

Responses

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a related item by id for attachments.

path Parameters
id
required
string <JSON>

Proposal id

fk
required
string <JSON>

Foreign key for attachments

Responses

Update a related item by id for attachments.

path Parameters
id
required
string <JSON>

Proposal id

fk
required
string <JSON>

Foreign key for attachments

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Queries measurementPeriods of Proposal.

path Parameters
id
required
string <JSON>

Proposal id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in measurementPeriods of this model.

path Parameters
id
required
string <JSON>

Proposal id

Request Body schema:
id
required
string

id currently needed by limitation in embedsmany

instrument
required
string

Instrument or beamline identifier where measurement was pursued, e.g. /PSI/SLS/TOMCAT

start
string <date-time>

Time when measurement period started, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

end
string <date-time>

Time when measurement period ended, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server

comment
string

Additional information relevant for this measurement period, e.g. if different accounts were used for data taking

Responses

Request samples

Content type
{
  • "id": "string",
  • "instrument": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "instrument": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "comment": "string"
}

Deletes all measurementPeriods of this model.

path Parameters
id
required
string <JSON>

Proposal id

Responses

Counts measurementPeriods of Proposal.

path Parameters
id
required
string <JSON>

Proposal id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Queries attachments of Proposal.

path Parameters
id
required
string <JSON>

Proposal id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in attachments of this model.

path Parameters
id
required
string <JSON>

Proposal id

Request Body schema:
thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Deletes all attachments of this model.

path Parameters
id
required
string <JSON>

Proposal id

Responses

Counts attachments of Proposal.

path Parameters
id
required
string <JSON>

Proposal id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Proposal id

Request Body schema:

An object of model property name/value pairs

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

proposalId
required
string

Globally unique identifier of a proposal, eg. PID-prefix/internal-proposal-number. PID prefix is auto prepended

pi_email
string

Email of principal investigator

pi_firstname
string

First name of principal investigator

pi_lastname
string

Last name of principal investigator

email
required
string

Email of main proposer

firstname
string

First name of main proposer

lastname
string

Last name of main proposer

title
string
abstract
string
startTime
string <date-time>
endTime
string <date-time>
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
Array of objects (MeasurementPeriod)

Responses

Request samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Find proposal that took data at specified instrument and time

query Parameters
instrument
string
measureTime
string <date-time>

Responses

Response samples

Content type
{
  • "findByInstrumentAndDate": { }
}

Search text inside proposal

Responses

Response samples

Content type
{
  • "searchText": { }
}

Return proposals fulfilling complex filter conditions, including from fields of joined models.

query Parameters
fields
string <JSON>

Define the filter conditions by specifying the name of values of fields requested. There is also support for a text search to look for strings anywhere in the proposal. Skip and limit parameters allow for paging.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

PublishedData

Stores the meta data information for an accessible, published and DOI-identified collection of datasets. It defines a list of mandatory and optional metadata fields to be included. DataCite mandatory fields, a full URL to the landing page and modification times are included.

Find a related item by id for datasets.

path Parameters
id
required
string <JSON>

PublishedData id

fk
required
string <JSON>

Foreign key for datasets

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Delete a related item by id for datasets.

path Parameters
id
required
string <JSON>

PublishedData id

fk
required
string <JSON>

Foreign key for datasets

Responses

Update a related item by id for datasets.

path Parameters
id
required
string <JSON>

PublishedData id

fk
required
string <JSON>

Foreign key for datasets

Request Body schema:
pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Queries datasets of PublishedData.

path Parameters
id
required
string <JSON>

PublishedData id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in datasets of this model.

path Parameters
id
required
string <JSON>

PublishedData id

Request Body schema:
pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Deletes all datasets of this model.

path Parameters
id
required
string <JSON>

PublishedData id

Responses

Counts datasets of PublishedData.

path Parameters
id
required
string <JSON>

PublishedData id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

PublishedData id

Request Body schema:

An object of model property name/value pairs

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

PublishedData.formPopulate

query Parameters
pid
required
string

Responses

Response samples

Content type
{ }

PublishedData.register

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "doi": "string"
}

PublishedData.resync

path Parameters
id
required
string
Request Body schema:
doi
required
string

Digital Object Identifier

affiliation
string

Creator Affiliation

creator
required
Array of strings

Creator of dataset/dataset collection

publisher
required
string

Dataset publisher

publicationYear
required
number <double>

Year of publication

title
required
string

Title

url
string

Full URL to the landing page for this DOI

abstract
required
string

Abstract text for published datasets

dataDescription
required
string

Link to description of how to re-use data

resourceType
required
string

e.g. raw/ derived

numberOfFiles
number <double>

Number of files

sizeOfArchive
number <double>

Size of archive

pidArray
required
Array of strings

Array of one or more PIDS which make up the published data

authors
Array of strings

List of Names of authors of the to be published data

registeredTime
string <date-time>

Time when doi is successfully registered

status
string

Indication of position in publication workflow e.g. doiRegistered

scicatUser
string

The username of the user that clicks the publish button in the client

thumbnail
string

Small, less than 16 MB base 64 image preview of dataset

relatedPublications
Array of strings

List of URLs pointing to related publications like DOI URLS of journal articles

downloadLink
string

URL pointing to page from which data can be downloaded

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "doi": "string",
  • "affiliation": "string",
  • "creator":
    [
    ],
  • "publisher": "string",
  • "publicationYear": 0,
  • "title": "string",
  • "url": "string",
  • "abstract": "string",
  • "dataDescription": "string",
  • "resourceType": "string",
  • "numberOfFiles": 0,
  • "sizeOfArchive": 0,
  • "pidArray":
    [
    ],
  • "authors":
    [
    ],
  • "registeredTime": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "scicatUser": "string",
  • "thumbnail": "string",
  • "relatedPublications":
    [
    ],
  • "downloadLink": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "doi": "string"
}

Datablock

When archiving a dataset all files contained in the dataset are listed here together with their checksum information. Several datablocks can be created if the file listing is too long for a single datablock. This partitioning decision is done by the archiving system to allow for chunks of datablocks with managable sizes. E.g a dataset consisting of 10 TB of data could be split into 10 datablocks of about 1 TB each. The upper limit set by the data catalog system itself is given by the fact that documents must be smaller than 16 MB, which typically allows for datasets of about 100000 files.

Fetches belongsTo relation dataset.

path Parameters
id
required
string <JSON>

Datablock id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Datablock id

Request Body schema:

An object of model property name/value pairs

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

id
required
string

Catalog internal UUIDv4 for datablock

archiveId
required
string

Unique identifier given bey archive system to the stored datablock. This id is used when data is retrieved back.

size
required
number <double>

Total size in bytes of all files in datablock when unpacked

packedSize
number <double>

Size of datablock package file

chkAlg
string

Algoritm used for calculation of checksums, e.g. sha2

version
required
string

Version string defining format of how data is packed and stored in archive

required
Array of objects (Datafile)
ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "archiveId": "string",
  • "size": 0,
  • "packedSize": 0,
  • "chkAlg": "string",
  • "version": "string",
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

UserCredential

Fetches belongsTo relation user.

path Parameters
id
required
string <JSON>

UserCredential id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

UserCredential id

Request Body schema:

An object of model property name/value pairs

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

provider
string
authScheme
string
externalId
string
profile
object
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "externalId": "string",
  • "profile": { },
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

UserIdentity

Fetches belongsTo relation user.

path Parameters
id
required
string <JSON>

UserIdentity id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

UserIdentity id

Request Body schema:

An object of model property name/value pairs

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

id
number <double>
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "id": 0,
  • "userId": "string"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

ApplicationCredential

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

ApplicationCredential id

Request Body schema:

An object of model property name/value pairs

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

provider
required
string
authScheme
string
credentials
object
created
string <date-time>
modified
string <date-time>
id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "provider": "string",
  • "authScheme": "string",
  • "credentials": { },
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "id": "string"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Policy

Definition of policy parameters relevant for the storgae lifecycle management of the datasets

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Policy id

Request Body schema:

An object of model property name/value pairs

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

manager
Array of strings

Defines the emails of users that can modify the policy parameters

tapeRedundancy
string
Default: "low"

Defines the level of redundancy in storage to minimize loss of data. Allowed values are low, medium, high. Low could e.g. mean one tape copy only, medium could mean two tape copies and high two geo-redundant tape copies

autoArchive
boolean
Default: true

Flag to indicate that a dataset should be automatically archived after ingest. If false then archive delay is ignored

autoArchiveDelay
number <double>
Default: 7

Number of days after dataset creation that (remaining) datasets are archived automatically

archiveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to archiveEmailsToBeNotified upon an archive job creation

archiveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up an archive job creation

retrieveEmailNotification
boolean
Default: false

Flag is true when an email notification should be sent to retrieveEmailsToBeNotified upon a retrieval job creation

retrieveEmailsToBeNotified
Array of strings

Array of additional email addresses that should be notified up a retrieval job creation

embargoPeriod
number <double>
Default: 3

Number of years after dataset creation before the dataset becomes public

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "manager":
    [
    ],
  • "tapeRedundancy": "low",
  • "autoArchive": true,
  • "autoArchiveDelay": 7,
  • "archiveEmailNotification": false,
  • "archiveEmailsToBeNotified":
    [
    ],
  • "retrieveEmailNotification": false,
  • "retrieveEmailsToBeNotified":
    [
    ],
  • "embargoPeriod": 3,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

updates multiple records on the Policy model and uses ownerGroup to identify those records

Request Body schema: application/x-www-form-urlencoded
ownerGroupList
required
string

Comma-separated string of owner groups to update e.g. "p14159, p24959"

data
required
string <JSON>

Responses

Response samples

Content type
{ }

Job

This collection keeps information about jobs to be excuted in external systems. In particular it keeps information about the jobs submitted for archiving or retrieving datasets stored inside an archive system. It can also be used to keep track of analysis jobs e.g. for automated analysis workflows.

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Job id

Request Body schema:

An object of model property name/value pairs

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Job id

Request Body schema:

An object of model property name/value pairs

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

emailJobInitiator
required
string

The email of the person initiating the job request

type
required
string
Default: "retrieve"

Type of job, e.g. archive, retrieve etc

creationTime
string <date-time>

Time when job is created. Format according to chapter 5.6 internet date/time format in RFC 3339

executionTime
string <date-time>

Time when job should be executed. If not specified then the Job will be executed asap. Format according to chapter 5.6 internet date/time format in RFC 3339

jobParams
object

Object of key-value pairs defining job input parameters, e.g. 'desinationPath' for retrieve jobs or 'tapeCopies' for archive jobs

jobStatusMessage
string

Defines current status of job lifecycle

datasetList
required
object

Array of objects with keys: pid, files. The value for the pid key defines the dataset ID, the value for the files key is an array of file names. This array is either an empty array, implying that all files within the dataset are selected or an explicit list of dataset-relative file paths, which should be selected

jobResultObject
object

Detailed return value after job is finished

id
string (ObjectID) ^[a-fA-F\d]{24}$
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "emailJobInitiator": "string",
  • "type": "retrieve",
  • "creationTime": "2019-08-24T14:15:22Z",
  • "executionTime": "2019-08-24T14:15:22Z",
  • "jobParams": { },
  • "jobStatusMessage": "string",
  • "datasetList": { },
  • "jobResultObject": { },
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Returns for all linked datasets the details as defined in the fields array. Useful to avoid URL size limititations for large dataset queries

query Parameters
jobId
string
datasetFields
string <JSON>
include
string <JSON>
includeFields
string <JSON>

Responses

Response samples

Content type
{ }

ShareGroup

Definition of groups to share datasets between scicat users

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

ShareGroup id

Request Body schema:

An object of model property name/value pairs

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

groupID
string

group short name id

members
Array of strings

Defines the emails of users that data is shared to

datasets
Array of strings

Defines the datasets which are shared

id
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "groupID": "string",
  • "members":
    [
    ],
  • "datasets":
    [
    ],
  • "id": "string"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

ShareGroup.getGroups

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "groups": { }
}

OrigDatablock

Container list all files and their attributes which make up a dataset. Usually Filled at the time the datasets metadata is created in the data catalog. Can be used by subsequent archiving processes to create the archived datasets.

Fetches belongsTo relation dataset.

path Parameters
id
required
string <JSON>

OrigDatablock id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

OrigDatablock id

Request Body schema:

An object of model property name/value pairs

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

id
string (ObjectID) ^[a-fA-F\d]{24}$
size
required
number <double>

Total size in bytes of all files contained in the dataFileList

required
Array of objects (Datafile)

List of files contained in the linked dataset. Files can be regular files, folders and softlinks. All file paths are relative paths with respect to the sourceFolder location of the linked dataset.

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

datasetId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "id": "string",
  • "size": 0,
  • "dataFileList":
    [
    ],
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

Returns matching file objects in dataFileList grouped by dataset pid

query Parameters
fields
string <JSON>

Define datasetId field to select a dataset and/or the filenameExp field to define a search regexp for file names.

limits
string <JSON>

Define further query parameters like skip, limit, order

Responses

Response samples

Content type
{ }

Logbook

Find Logbook model instance

path Parameters
name
required
string

Name of the Logbook

Responses

Response samples

Content type
{
  • "name": "string",
  • "roomId": "string",
  • "messages":
    [
    ]
}

Find all Logbook model instances

Responses

Response samples

Content type
[
  • {
    }
]

Filter Logbook entries matching query

path Parameters
name
required
string

The name of the Logbook

filters
required
string

Filter rison object, keys: textSearch, showBotMessages, showUserMessages, showImages, skip, limit, sortField

Responses

Response samples

Content type
{
  • "name": "string",
  • "roomId": "string",
  • "messages":
    [
    ]
}

Attachment

Small less than 16 MB attachments, envisaged for png/jpeg previews

Fetches belongsTo relation dataset.

path Parameters
id
required
string <JSON>

Attachment id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Fetches belongsTo relation sample.

path Parameters
id
required
string <JSON>

Attachment id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "sampleId": "string",
  • "owner": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "sampleCharacteristics": { },
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "datasetsId": "string",
  • "datasetId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Fetches belongsTo relation proposal.

path Parameters
id
required
string <JSON>

Attachment id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "proposalId": "string",
  • "pi_email": "string",
  • "pi_firstname": "string",
  • "pi_lastname": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "title": "string",
  • "abstract": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "MeasurementPeriodList":
    [
    ]
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Attachment id

Request Body schema:

An object of model property name/value pairs

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

thumbnail
required
string
Default: "retrieve"

Contains a thumbnail preview in base64 encoded png format for a given dataset

caption
string
Default: ""

Attachment caption to show in catanie

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

id
string (ObjectID) ^[a-fA-F\d]{24}$
datasetId
string
sampleId
string
proposalId
string
rawDatasetId
string
derivedDatasetId
string
createdAt
string <date-time>
updatedAt
string <date-time>

Responses

Request samples

Content type
{
  • "thumbnail": "retrieve",
  • "caption": "",
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "id": "string",
  • "datasetId": "string",
  • "sampleId": "string",
  • "proposalId": "string",
  • "rawDatasetId": "string",
  • "derivedDatasetId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Check if data is valid according to a schema

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
{ }

UserSetting

User settings such as job count and dataset count

Fetches belongsTo relation user.

path Parameters
id
required
string <JSON>

UserSetting id

query Parameters
refresh
boolean

Responses

Response samples

Content type
{
  • "realm": "string",
  • "username": "string",
  • "email": "string",
  • "emailVerified": true,
  • "id": "string"
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

UserSetting id

Request Body schema:

An object of model property name/value pairs

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

columns
Array of objects
datasetCount
number <double>
Default: 25
jobCount
number <double>
Default: 25
id
string (ObjectID) ^[a-fA-F\d]{24}$
userId
string (ObjectID) ^[a-fA-F\d]{24}$

Responses

Request samples

Content type
{
  • "columns":
    [
    ],
  • "datasetCount": 25,
  • "jobCount": 25,
  • "id": "string",
  • "userId": "string"
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

Instrument

Stores metadata information for an instrument

Find a related item by id for datasets.

path Parameters
id
required
string <JSON>

Instrument id

fk
required
string <JSON>

Foreign key for datasets

Responses

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Delete a related item by id for datasets.

path Parameters
id
required
string <JSON>

Instrument id

fk
required
string <JSON>

Foreign key for datasets

Responses

Update a related item by id for datasets.

path Parameters
id
required
string <JSON>

Instrument id

fk
required
string <JSON>

Foreign key for datasets

Request Body schema:
pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Queries datasets of Instrument.

path Parameters
id
required
string <JSON>

Instrument id

query Parameters
filter
string <JSON>

Responses

Response samples

Content type
[
  • {
    }
]

Creates a new instance in datasets of this model.

path Parameters
id
required
string <JSON>

Instrument id

Request Body schema:
pid
required
string

Persistent Identifier for datasets derived from UUIDv4 and prepended automatically by site specific PID prefix like 20.500.12345/

owner
required
string

Owner of the data set, usually first name + lastname

ownerEmail
string

Email of owner of the data set

orcidOfOwner
string

ORCID of owner https://orcid.org if available

contactEmail
required
string

Email of contact person for this dataset

sourceFolder
required
string

Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.

sourceFolderHost
string

DNS host name of file server hosting sourceFolder, optionally including protocol e.g. [protocol://]fileserver1.example.com

size
number <double>

Total size of all source files contained in source folder on disk when unpacked

packedSize
number <double>

Total size of all datablock package files created for this dataset

numberOfFiles
number <double>

Total number of lines in filelisting of all OrigDatablocks for this dataset

numberOfFilesArchived
number <double>

Total number of lines in filelisting of all Datablocks for this dataset

creationTime
required
string <date-time>

Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.

type
required
string

Characterize type of dataset, either 'base' or 'raw' or 'derived'. Autofilled when choosing the proper inherited models

validationStatus
string

Defines a level of trust, e.g. a measure of how much data was verified or used by other persons

keywords
Array of strings

Array of tags associated with the meaning or contents of this dataset. Values should ideally come from defined vocabularies, taxonomies, ontologies or knowledge graphs

description
string

Free text explanation of contents of dataset

datasetName
string

A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder

classification
string

ACIA information about AUthenticity,COnfidentiality,INtegrity and AVailability requirements of dataset. E.g. AV(ailabilty)=medium could trigger the creation of a two tape copies. Format 'AV=medium,CO=low'

license
string

Name of license under which data can be used

version
string

Version of API used in creation of dataset

isPublished
boolean

Flag is true when data are made publically available

ownerGroup
required
string

Defines the group which owns the data, and therefore has unrestricted access to this data. Usually a pgroup like p12151

accessGroups
Array of strings

Optional additional groups which have read access to the data. Users which are member in one of the groups listed here are allowed to access this data. The special group 'public' makes data available to all users

createdBy
string

Functional or user account name who created this instance

updatedBy
string

Functional or user account name who last updated this instance

createdAt
string <date-time>
updatedAt
string <date-time>
publishedDataId
string
publisheddataId
string
object (DatasetLifecycle)

For each dataset there exists an embedded dataset lifecycle document which describes the current status of the dataset during its lifetime with respect to the storage handling systems

Array of objects (Message)
instrumentId
string
Array of objects (Technique)

Responses

Request samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Response samples

Content type
{
  • "pid": "string",
  • "owner": "string",
  • "ownerEmail": "string",
  • "orcidOfOwner": "string",
  • "contactEmail": "string",
  • "sourceFolder": "string",
  • "sourceFolderHost": "string",
  • "size": 0,
  • "packedSize": 0,
  • "numberOfFiles": 0,
  • "numberOfFilesArchived": 0,
  • "creationTime": "2019-08-24T14:15:22Z",
  • "type": "string",
  • "validationStatus": "string",
  • "keywords":
    [
    ],
  • "description": "string",
  • "datasetName": "string",
  • "classification": "string",
  • "license": "string",
  • "version": "string",
  • "isPublished": true,
  • "ownerGroup": "string",
  • "accessGroups":
    [
    ],
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "publishedDataId": "string",
  • "publisheddataId": "string",
  • "datasetlifecycle":
    {
    },
  • "history":
    [
    ],
  • "instrumentId": "string",
  • "techniques":
    [
    ]
}

Deletes all datasets of this model.

path Parameters
id
required
string <JSON>

Instrument id

Responses

Counts datasets of Instrument.

path Parameters
id
required
string <JSON>

Instrument id

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a new instance of the model and persist it into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Patch an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Find all instances of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
[
  • {
    }
]

Replace an existing model instance or insert a new one into the data source.

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Check whether a model instance exists in the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{
  • "exists": true
}

Find a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

query Parameters
filter
string <JSON>

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Delete a model instance by {{id}} from the data source.

path Parameters
id
required
string <JSON>

Model id

Responses

Response samples

Content type
{ }

Patch attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Instrument id

Request Body schema:

An object of model property name/value pairs

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Replace attributes for a model instance and persist it into the data source.

path Parameters
id
required
string <JSON>

Model id

Request Body schema:

Model instance data

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Find first instance of the model matched by filter from the data source.

query Parameters
filter
string <JSON>

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"where":{"something":"value"}}). See https://loopback.io/doc/en/lb3/Querying-data.html#using-stringified-json-in-rest-queries for more details.

Responses

Response samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Update instances of the model matched by {{where}} from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Request Body schema:

An object of model property name/value pairs

pid
required
string

Persistent Identifier derived from UUIDv4

name
required
string
customMetadata
object

Responses

Request samples

Content type
{
  • "pid": "string",
  • "name": "string",
  • "customMetadata": { }
}

Response samples

Content type
{
  • "count": 0
}

Count instances of the model matched by where from the data source.

query Parameters
where
string <JSON>

Criteria to match model instances

Responses

Response samples

Content type
{
  • "count": 0
}

Create a change stream.

Request Body schema: application/x-www-form-urlencoded
options
string <JSON>

Responses

Response samples

Content type
"string"

Create a change stream.

query Parameters
options
string <JSON>

Responses

Response samples

Content type
"string"

RabbitMQ

Provide access to RabbitMQ server stats and queues.

Get an status overview of the connected rabbitmq server

Responses

Response samples

Content type
{ }

Get queues of connected rabbitmq server

Responses

Response samples

Content type
[
  • { }
]